|
Eclipse Platform Pre-release 3.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
The extension registry holds the master list of all discovered elements, extension points and extensions.
The extension registry can be queried, by name, for extension points and extensions.
Extensions and extension points are declared by generic entities called elements. The only fact known about elements is that they have unique string-based identifiers.
This interface is not intended to be implemented by clients.
Method Summary | |
void |
addRegistryChangeListener(IRegistryChangeListener listener)
Adds the given listener for registry change events. |
void |
addRegistryChangeListener(IRegistryChangeListener listener,
String elementId)
Adds the given listener for registry change events related to the given element. |
IConfigurationElement[] |
getConfigurationElementsFor(String extensionPointId)
Returns all configuration elements from all extensions configured into the identified extension point. |
IConfigurationElement[] |
getConfigurationElementsFor(String elementId,
String extensionPointName)
Returns all configuration elements from all extensions configured into the identified extension point. |
IConfigurationElement[] |
getConfigurationElementsFor(String elementId,
String extensionPointName,
String extensionId)
Returns all configuration elements from the identified extension. |
String[] |
getElementIdentifiers()
Returns all elements that declare extensions and/or extension points. |
IExtension |
getExtension(String extensionPointId,
String extensionId)
Returns the specified extension in this extension registry, or null if there is no such extension. |
IExtension |
getExtension(String elementId,
String extensionPointName,
String extensionId)
Returns the specified extension in this extension registry, or null if there is no such extension. |
IExtensionPoint |
getExtensionPoint(String extensionPointId)
Returns the extension point with the given extension point identifier in this extension registry, or null if there is no such
extension point. |
IExtensionPoint |
getExtensionPoint(String elementId,
String extensionPointName)
Returns the extension point in this extension registry with the given element identifier and extension point simple identifier, or null if there is no such extension point. |
IExtensionPoint[] |
getExtensionPoints()
Returns all extension points known to this extension registry. |
IExtensionPoint[] |
getExtensionPoints(String elementId)
Returns all extension points declared by the given element. |
IExtension[] |
getExtensions(String elementId)
Returns all extensions declared by the given element. |
void |
removeRegistryChangeListener(IRegistryChangeListener listener)
Removes the given registry change listener from this registry. |
Method Detail |
public void addRegistryChangeListener(IRegistryChangeListener listener, String elementId)
Once registered, a listener starts receiving notification of changes to the registry. Registry change notifications are sent asynchronously. The listener continues to receive notifications until it is removed.
listener
- the listenerelementId
- the identifier of the element to which to listen for changesIRegistryChangeListener
,
IRegistryChangeEvent
,
removeRegistryChangeListener(org.eclipse.core.runtime.IRegistryChangeListener)
public void addRegistryChangeListener(IRegistryChangeListener listener)
This method is equivalent to:
addRegistryChangeListener(listener,null);
listener
- the listenerIRegistryChangeListener
,
IRegistryChangeEvent
,
addRegistryChangeListener(IRegistryChangeListener, String)
,
removeRegistryChangeListener(org.eclipse.core.runtime.IRegistryChangeListener)
public IConfigurationElement[] getConfigurationElementsFor(String extensionPointId)
extensionPointId
- the unique identifier of the extension point
(e.g. "org.eclipse.core.resources.builders"
)
public IConfigurationElement[] getConfigurationElementsFor(String elementId, String extensionPointName)
elementId
- the unique identifier of the element
(e.g. "org.eclipse.core.resources"
)extensionPointName
- the simple identifier of the
extension point (e.g. "builders"
)
public IConfigurationElement[] getConfigurationElementsFor(String elementId, String extensionPointName, String extensionId)
elementId
- the unique identifier of the element
(e.g. "org.eclipse.core.resources"
)extensionPointName
- the simple identifier of the
extension point (e.g. "builders"
)extensionId
- the unique identifier of the extension
(e.g. "com.example.acme.coolbuilder
)
public IExtension getExtension(String extensionPointId, String extensionId)
null
if there is no such extension.
The first parameter identifies the extension point, and the second
parameter identifies an extension plugged in to that extension point.
extensionPointId
- the unique identifier of the extension point
(e.g. "org.eclipse.core.resources.builders"
)extensionId
- the unique identifier of the extension
(e.g. "com.example.acme.coolbuilder"
)
null
public IExtension getExtension(String elementId, String extensionPointName, String extensionId)
null
if there is no such extension.
The first two parameters identify the extension point, and the third
parameter identifies an extension plugged in to that extension point.
elementId
- the unique identifier of the element
(e.g. "org.eclipse.core.resources"
)extensionPointName
- the simple identifier of the
extension point (e.g. "builders"
)extensionId
- the unique identifier of the extension
(e.g. "com.example.acme.coolbuilder"
)
null
public IExtensionPoint getExtensionPoint(String extensionPointId)
null
if there is no such
extension point.
extensionPointId
- the unique identifier of the extension point
(e.g., "org.eclipse.core.resources.builders"
)
null
public IExtensionPoint getExtensionPoint(String elementId, String extensionPointName)
null
if there is no such extension point.
elementId
- the unique identifier of the element
(e.g. "org.eclipse.core.resources"
)extensionPointName
- the simple identifier of the
extension point (e.g. " builders"
)
null
public IExtensionPoint[] getExtensionPoints()
public IExtensionPoint[] getExtensionPoints(String elementId)
elementId
- the unique identifier of the element
(e.g. "org.eclipse.core.resources"
)
public IExtension[] getExtensions(String elementId)
elementId
- the unique identifier of the element
(e.g. "org.eclipse.core.resources"
)
public String[] getElementIdentifiers()
public void removeRegistryChangeListener(IRegistryChangeListener listener)
listener
- the listenerIRegistryChangeListener
,
addRegistryChangeListener(org.eclipse.core.runtime.IRegistryChangeListener, java.lang.String)
|
Eclipse Platform Pre-release 3.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |